Function Reference

_TS_FolderGet

Returns the object of the specified Folder.

#Include <TaskScheduler.au3>
_TS_FolderGet($oService, $sFolder)

Parameters

$oService	Task Scheduler Service object as returned by _TS_Open
$sFolder	The absolute path to the Folder to be processed

Return Value

Success: Object of the specified Folder
Failure: Returns 0 and sets @error:
901 - Error accessing the specified Folder. @extended is set to the COM error code

Remarks

None.

Related

Example

#Region ;**** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Res_requestedExecutionLevel=asInvoker
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7
#EndRegion ;**** Directives created by AutoIt3Wrapper_GUI ****

#include <TaskScheduler.au3>

; *****************************************************************************
; Connect to the Task Scheduler Service
; *****************************************************************************
Global $oService = _TS_Open()
If @error <> 0 Then Exit MsgBox($MB_ICONERROR, "Task Scheduler UDF", "Error connecting to the Task Scheduler Service. @error = " & @error & ", @extended = " & @extended & @CRLF & @CRLF & _TS_ErrorText(@error))

; *****************************************************************************
; Get the object of a folder
; *****************************************************************************
Global $sFolder = "\Microsoft\Windows\.Net Framework"
Global $oFolder = _TS_FolderGet($oService, $sFolder)
If Not @error Then
MsgBox($MB_ICONINFORMATION, "_TS_FolderGet", "Successfully accessed folder: " & $sFolder & @CRLF & "Name: " & $oFolder.Name & @CRLF & "Path:" & $oFolder.Path)
Else
MsgBox($MB_ICONERROR, "_TS_FolderGet", "Returned @error=" & @error & ", @extended=" & @extended & @CRLF & @CRLF & _TS_ErrorText(@error))
EndIf
_TS_Close()